Gets a webhook attempt or response

SecurityAuthToken
Request
path Parameters
webhookAttemptId
required
string

The unique ID of the webhook attempt or response.

Responses
200

OK

Response Schema: application/json
id
string

The webhook attempt's unique identifier. This is a lexicographically sortable identifier.

attempted_at
string <date-time>

Date/time in ISO-8601 format at which the webhook attempt related to the webhook attempt occurred.

completed_at
string <date-time>

Date/time in ISO-8601 format at which the webhook attempt or response completed.

event_id
string

The unique ID of the event that is associated with the webhook delivery attempt or response.

webhook_config_id
string

The unique ID of the WebhookConfig that is associated with the webhook delivery attempt or response.

webhook_config_url
string

The URL of the WebhookConfig. This is the URL that is associated with the webhook delivery attempt or response.

response_code
integer or null

The webhook attempt's integer HTTP status code (e.g. HTTP response codes like 200, 404, 400, 202, 500, etc.). If the webhook url or endpoint times out after 10 seconds, the response code value for a timeout is set to null.

response_body
string

The response body received from executing the webhook. This is the response that the webhook endpoint returned.

response_headers
string

JSON-serialized key-value pairs of the HTTP response headers from the webhook attempt or response.

self_link
string

HTTP URL to this WebhookAttempt.

404

Not found

get/webhooks/attempts/{webhookAttemptId}/
Request samples
Response samples
application/json
{
  • "id": "string",
  • "attempted_at": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "event_id": "string",
  • "webhook_config_id": "string",
  • "webhook_config_url": "string",
  • "response_code": 200,
  • "response_body": "string",
  • "response_headers": "{\"some_key\": \"some_value\", \"Content-Type\": \"application/json\", \"another_key\": \"another_value\"}",
  • "self_link": "string"
}
Copyright © Shipwell 2024. All right reserved.